package com.atguigu.shiro.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * ①通过@Configuration注解，让Spring来加载该配置类
 * ②再通过@EnableSwagger2注解来启动Swagger2
 * 项目启动地址：http://127.0.0.1:10086/api/swagger-ui.html
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {

    //③再通过createRestApi函数创建Docket的Bean
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现
                //本例采用指定扫描的注解来定义，Swagger会扫描该注解的所有定义的API，并产生文档内容
                .select()
                                              //扫描所有带有@RestController注解的API
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                 //.apis(RequestHandlerSelectors.basePackage("com.didispace.web"))
                 //采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。
                .paths(PathSelectors.any())
                .build();
    }
    //apiInfo()用来创建该API的基本信息(这些基本信息会展现在文档页面中)
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("Swagger2API文档")
                .description("restful风格")
                .version("1.0")
                .build();
    }
}
